home *** CD-ROM | disk | FTP | other *** search
/ Aminet 2 / Aminet AMIGA CDROM (1994)(Walnut Creek)[Feb 1994][W.O. 44790-1].iso / Aminet / dev / misc / autodocit_1_13.lha / getting_started.doc < prev   
Text File  |  1992-06-13  |  5KB  |  159 lines
  1.                              AUTODOC-IT 1.13
  2.  
  3.                           The Programmers Guide
  4.  
  5.                      © by Voyager@Treff.zer
  6.  
  7.  
  8. --------------------------------------------------------------------------
  9.  
  10. CONTENTS:
  11. =========
  12.  
  13.  
  14.  
  15. I   Introduction
  16. II  Requirements
  17. III Installation
  18. IV  Disclaimer
  19.  
  20. --------------------------------------------------------------------------
  21.  
  22. (Part I)
  23.  
  24. What is it?
  25.  
  26. AUTODOC-IT is a program in amigaguide/hypertext-format which helps you to get
  27. your autodocs (converted with ad2ht included in the amigaguide-package) together 
  28. in one document. I wrote it because I did not like to click on an icon every time, 
  29. when searching for a certain structure or description in the converted files. 
  30. Now  all you have  to know is: where is this structure I am searching...is it 
  31. in asl.guide or anywhere else...?
  32.  
  33. It is also a comfortable environment for working through the whole thing,
  34. because of cross-references. If you have problems in understanding a 
  35. specific word and it is marked by a BLUE-BOX, "click" - and you should get an
  36. explanation...just like in an encyclopedia. 
  37.  
  38. This means, that - if you e.g. load the dos-autodoc-file from within autodoc-it 
  39. and click on the function CLI(), you can - from there get information about 
  40. the syntax of "Lock" by just clicking on the text. autodoc-it will then 
  41. load dosextens.h.
  42.  
  43. With autodoc-it you have not just autodocs at your service (with all cross
  44. references) but also the information contained in the C-includes!
  45.  
  46. This project should, as well, encourage more programmers to use an amigaguide-
  47. compatible format in their programs, it is not that hard to understand.
  48.  
  49. Examples of programs, which already use amigaguide for a (more or less) context 
  50. sensitive help system: SUPERDUPER, AMI-BACK 2.0A, DMSWIN 2.0
  51.  
  52.  
  53. --------------------------------------------------------------------------
  54.  
  55. (Part II)
  56.  
  57. System requirements:
  58.  
  59. Hardware:
  60.  
  61. - AMIGA (what else?) with Kickstart/Workbench 2.0 and some Ram:-)
  62. - A harddisk (the bigger the better:-))
  63.  
  64. Software:
  65.  
  66. - Amigaguide Distribution Package
  67. - Autodoc-distribution-files or already converted .doc files (2.x)
  68. - 2.0 C-Header Files (included in DevCon distributions, e.g. 2.04).
  69.  
  70. --------------------------------------------------------------------------
  71.  
  72. (Part III)
  73.  
  74. Walkthrough:
  75.  
  76. This is a short description of what should be done BEFORE you try starting
  77. your AUTODOC-IT Script.
  78.  
  79. First of all, get yourself the amigaguide-package. If you are a registered 
  80. developer you can find it on your DEVCON disks. The autodocs are needed
  81. as well, the actual version is, as well, shipped to registered developers.
  82.  
  83. Your first step is to convert your existing autodocs into the new amigaguide
  84. format. This is discribed in the amigaguide documentation. You should have
  85. already installed the amigaguide package before!
  86.  
  87. Check, if env: contains a directory named "amigaguide", with files called
  88. "path" and "text". 
  89.  
  90. Path contains the path to your amigaguide directory. If path is not 
  91. present, type:
  92.  
  93. setenv amigaguide/path <DEV:COMPLETE_PATH>
  94.  
  95. If text is not present, type:
  96.  
  97. setenv amigaguide/text BUTTON
  98.  
  99. Take care, that these settings are really saved, otherwise they are gone after
  100. a reset. If you have env: assigned to ram:, copy the amigaguide/path and
  101. amigaguide/text to envarc: on your Harddisk. I should not mention this,
  102. because it is all in the amigaguide docs...
  103.  
  104. Okay, now find a suitable directory on your Harddisk, where amigaguide-text-
  105. files should reside. Note, that this directory can grow quite a bit, 
  106. because in the future there will be many more programs supporting amigaguide.
  107.  
  108. Add a line to your Startup-Sequence: 
  109.  
  110. assign amigaguide: <DEV:COMPLETE_PATH>
  111. assign include: <DEV:COMPLETE_PATH>
  112.  
  113. I recommend to follow the next steps as well, although they are
  114. not needed to let AUTODOC-IT work...:
  115.  
  116. 1. Put AUTODOC.IT into your amigaguide directory and select its icon. 
  117.  
  118. 2. Choose LEAVE OUT from the Workbench Menu "Icons". This way, you have your
  119.    AUTODOC-IT always in sight when you need it. -
  120.  
  121. You should copy your C-header-files (*.h-type-files) into the amigaguide
  122. directory as well (but put it in a subdirectory or you will face some
  123. problems with the converted .doc files and the directory names of the
  124. includes, e.g. exec is a dir but also a converted autodoc.file!). This way, 
  125. amigaguide can find  cross-references between several documents which are sometimes 
  126. not in the autodocs. 
  127.  
  128. If something does not work the way it should, try snoopdos and find out,
  129. which files AUTODOC-IT cannot find. If you put all your stuff in a
  130. directory which amigaguide knows from its PATH-ENVIRONMENT-VARIABLE,
  131. it should work...
  132.  
  133. --------------------------------------------------------------------------
  134.  
  135. (Part IV)
  136.  
  137. Copyright notice:
  138.  
  139. Feel free to adapt this program to your own needs, if you want to redistribute
  140. it, add a note to the AUTODOC-IT header (but do not delete it!) and spread
  141. the complete archive as stated in contents.txt. If you
  142. accept this and do not try to profit from it, AUTODOC-IT is FREEWARE.
  143.  
  144. Note however, that, like always (even with FREEWARE, yes!), I own the
  145. copyright.
  146.  
  147. --------------------------------------------------------------------------
  148.  
  149. Maybe you have some interesting proposals, flames etc..? Then e-mail via
  150. Z-NET to:  VOYAGER@TREFF.ZER or VOYAGER@TREFF.ZER.DE in Usenet.
  151.  
  152.  
  153.  
  154.                     Ciao,
  155.  
  156.                     Voyager, 1992
  157.  
  158.  
  159.